REST API Overview

The IQM platform uses standard REST API calls and responses for its applications. Our API has URLs organized by resource, supports form-encoded requests, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://app.iqm.com

Review the following sections for the basic information on API specifications to avoid errors and workflow interruptions.

Prerequisites

The minimum requirements are: creating an account with IQM, running at least one Campaign, and attaining authentication to use the platform. Review the Getting Started page for details on these requirements before using the IQM API.

Once these steps are completed see the other Quickstart Guides and the Guidelines pages for a comprehensive overview of the IQM platform's API.

Authentication

The IQM API uses bearer authentication tokens to authenticate as well as an Organization Workspace ID (owId). Authentication is obtained on sign up and log in.

Refer to the Sign Up and Authenticate Quickstart Guide for more information.

HTTP Request Methods

Data resources are accessed via standard HTTP requests in UTF-8 format to an API endpoint. Refer to MDN Documentation on methods for more information.

The IQM API uses the following HTTP methods:

HTTP Methods
GET	Retrieves Resources
POST	Creates Resources
PUT	Changes or replaces resources
DEL	Deletes Resources
PATCH	Applies partial modification to a resource

Response Codes and Samples

IQM uses HTTP status codes. Please refer to MDN Documentation on status codes for more information.

API calls will return a JSON formatted response consisting of a success boolean and, often, a message, data, or error property describing the success or failure. Below is a table of common status codes and response samples.

Status Codes
200	OK
201	Created
400	Bad Request
403	Forbidden
408	Request Timeout
412	Precondition Failed
422	Unprocessable Entity
429	Too Many Requests
500	Internal Service Error

Response 200

{
  "success": true,
  "data": "PG deal Campaigns mappings updated successfully"
}

Response 422

{
  "success": false,
  "errorObjects": [
    {
      "error": "Campaign ID 506992 exceeds the maximum limit of 25 deals"
    }
  ]
}

Rate limits

The message rate limit is 20 requests per minute. Exceeding the limit will cause a 429 (too many requests) error.

The maximum data size per page is 1K rows.